/**
 * jsdoc-vue 配置文件
 */
module.exports = {
  tags: {
    allowUnknownTags: true,
    // 指定所用词典
    dictionaries: ["jsdoc"],
  },
  // 查找文件的深度 需要用 -r 参数
  recurseDepth: 10,
  source: {
    include: [
      // 需要编译的文件路径 使用时请替换
      "../src/skylibrary",
      "../src/App.vue",
    ],
    exclude: ["../src/skylibrary/utils",],
    includePattern: ".+\\.(vue|js)$",
    excludePattern: "(^|\\/|\\\\)_",
  },
  // 使用插件
  plugins: [
    // 插件路径
    "./jsdoc-vue",
  ],
  templates: {
    cleverLinks: false,
    monospaceLinks: true,
    useLongnameInNav: false,
    showInheritedInNav: true,
  },
  opts: {
    // 文档输出路径
    destination: "./example/doc",
    encoding: "utf8",
    private: true,
    recurse: true,
    // 使用模板 minami
    template: "./node_modules/docdash",
  },
  docdash: {
    // static: [false | true], // Display the static members inside the navbar
    sort: [false | true], // Sort the methods in the navbar
    sectionOrder: [
      // Order the main section in the navbar (default order shown here)
      "Classes",
      "Modules",
      "Externals",
      "Events",
      "Namespaces",
      "Mixins",
      "Tutorials",
      "Interfaces",
    ],
    disqus: "", // Shortname for your disqus (subdomain during site creation)
    meta: {
      // Meta information options (mostly for search engines that have not indexed your site yet)
      title: "", // Also will be used as postfix to actualy page title, prefixed with object/document name
      description: "", // Description of overal contents of your website
      keyword: "", // Keywords for search engines
    },
    search: [false | true], // Display seach box above navigation which allows to search/filter navigation items
    collapse: [false | true], // Collapse navigation by default except current object's navigation of the current page
    wrap: [false | true], // Wrap long navigation names instead of trimming them
    typedefs: [false | true], // Include typedefs in menu
    scopeInOutputPath: [false | true], // Add scope from package file (if present) to the output path, true by default.
    nameInOutputPath: [false | true], // Add name from package file to the output path, true by default.
    versionInOutputPath: [false | true], // Add package version to the output path, true by default.
  },
};
